<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.projectbrowser.page.loadingprocesspanel;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import org.apache.wicket.ResourceReference;<a name="line.3"></a>
<FONT color="green">004</FONT>    import org.apache.wicket.ajax.AjaxRequestTarget;<a name="line.4"></a>
<FONT color="green">005</FONT>    import org.apache.wicket.ajax.AjaxSelfUpdatingTimerBehavior;<a name="line.5"></a>
<FONT color="green">006</FONT>    import org.apache.wicket.markup.html.basic.MultiLineLabel;<a name="line.6"></a>
<FONT color="green">007</FONT>    import org.apache.wicket.markup.html.image.Image;<a name="line.7"></a>
<FONT color="green">008</FONT>    import org.apache.wicket.markup.html.panel.Panel;<a name="line.8"></a>
<FONT color="green">009</FONT>    import org.apache.wicket.model.PropertyModel;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.apache.wicket.util.time.Duration;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    /**<a name="line.12"></a>
<FONT color="green">013</FONT>     * Panel to show progress of a lengthy operation.<a name="line.13"></a>
<FONT color="green">014</FONT>     * This panel will show when process is in progress or process end not successfully.<a name="line.14"></a>
<FONT color="green">015</FONT>     * This panel will display the processingMessage.<a name="line.15"></a>
<FONT color="green">016</FONT>     * This panel will update every second via Ajax when process is in progress.<a name="line.16"></a>
<FONT color="green">017</FONT>     * For more detail, please see Processable interface.<a name="line.17"></a>
<FONT color="green">018</FONT>     * <a name="line.18"></a>
<FONT color="green">019</FONT>     * @author Shaoxuan Zhang<a name="line.19"></a>
<FONT color="green">020</FONT>     */<a name="line.20"></a>
<FONT color="green">021</FONT>    public class LoadingProcessPanel extends Panel {<a name="line.21"></a>
<FONT color="green">022</FONT>      /** Support serialization. */<a name="line.22"></a>
<FONT color="green">023</FONT>      private static final long serialVersionUID = 1L;<a name="line.23"></a>
<FONT color="green">024</FONT>      /** the data model. */<a name="line.24"></a>
<FONT color="green">025</FONT>      private Processable dataModel;<a name="line.25"></a>
<FONT color="green">026</FONT>      <a name="line.26"></a>
<FONT color="green">027</FONT>      /**<a name="line.27"></a>
<FONT color="green">028</FONT>       * @param id the wicket component id.<a name="line.28"></a>
<FONT color="green">029</FONT>       * @param model the data model associating with this panel.<a name="line.29"></a>
<FONT color="green">030</FONT>       */<a name="line.30"></a>
<FONT color="green">031</FONT>      // Has to suppress this warning because this constructor calls start() which calls onFinish which<a name="line.31"></a>
<FONT color="green">032</FONT>      // is an overridable method. Calling start() is necessary to start the Ajax auto update function<a name="line.32"></a>
<FONT color="green">033</FONT>      // if process is undergoing when every time this panel is created. The onFinish() method is not<a name="line.33"></a>
<FONT color="green">034</FONT>      // actually called when constructing. It is called within the timers interface method and will be<a name="line.34"></a>
<FONT color="green">035</FONT>      // called later.<a name="line.35"></a>
<FONT color="green">036</FONT>      @SuppressWarnings("PMD.ConstructorCallsOverridableMethod")<a name="line.36"></a>
<FONT color="green">037</FONT>      public LoadingProcessPanel(String id, Processable model) {<a name="line.37"></a>
<FONT color="green">038</FONT>        super(id);<a name="line.38"></a>
<FONT color="green">039</FONT>        this.dataModel = model;<a name="line.39"></a>
<FONT color="green">040</FONT>        MultiLineLabel label = <a name="line.40"></a>
<FONT color="green">041</FONT>          new MultiLineLabel("processingMessage", new PropertyModel(dataModel, "processingMessage"));<a name="line.41"></a>
<FONT color="green">042</FONT>        label.setOutputMarkupId(true);<a name="line.42"></a>
<FONT color="green">043</FONT>        add(label);<a name="line.43"></a>
<FONT color="green">044</FONT>        <a name="line.44"></a>
<FONT color="green">045</FONT>        //add loading image<a name="line.45"></a>
<FONT color="green">046</FONT>        Image loadingImage = new Image("loadingImage", <a name="line.46"></a>
<FONT color="green">047</FONT>            new ResourceReference(LoadingProcessPanel.class, "loading21-1.gif")) {<a name="line.47"></a>
<FONT color="green">048</FONT>          /** Support serialization. */<a name="line.48"></a>
<FONT color="green">049</FONT>          private static final long serialVersionUID = 1L;<a name="line.49"></a>
<FONT color="green">050</FONT>          @Override<a name="line.50"></a>
<FONT color="green">051</FONT>          public boolean isVisible() {<a name="line.51"></a>
<FONT color="green">052</FONT>            return dataModel.isInProcess();<a name="line.52"></a>
<FONT color="green">053</FONT>          }<a name="line.53"></a>
<FONT color="green">054</FONT>        };<a name="line.54"></a>
<FONT color="green">055</FONT>        add(loadingImage);<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>        if (dataModel.isInProcess()) {<a name="line.57"></a>
<FONT color="green">058</FONT>          start();<a name="line.58"></a>
<FONT color="green">059</FONT>        }<a name="line.59"></a>
<FONT color="green">060</FONT>      }<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>      /**<a name="line.62"></a>
<FONT color="green">063</FONT>       * start panel self update.<a name="line.63"></a>
<FONT color="green">064</FONT>       */<a name="line.64"></a>
<FONT color="green">065</FONT>      public final void start() {<a name="line.65"></a>
<FONT color="green">066</FONT>        AjaxSelfUpdatingTimerBehavior selfUpdateBehavior = <a name="line.66"></a>
<FONT color="green">067</FONT>          new AjaxSelfUpdatingTimerBehavior(Duration.milliseconds(200)) {<a name="line.67"></a>
<FONT color="green">068</FONT>          /** Support serialization. */<a name="line.68"></a>
<FONT color="green">069</FONT>          private static final long serialVersionUID = 1L;<a name="line.69"></a>
<FONT color="green">070</FONT>          @Override<a name="line.70"></a>
<FONT color="green">071</FONT>          protected void onPostProcessTarget(AjaxRequestTarget target) {<a name="line.71"></a>
<FONT color="green">072</FONT>            if (!dataModel.isInProcess()) {<a name="line.72"></a>
<FONT color="green">073</FONT>              // do custom action<a name="line.73"></a>
<FONT color="green">074</FONT>              onFinished(target);<a name="line.74"></a>
<FONT color="green">075</FONT>              // stop the self update<a name="line.75"></a>
<FONT color="green">076</FONT>              stop();<a name="line.76"></a>
<FONT color="green">077</FONT>            }<a name="line.77"></a>
<FONT color="green">078</FONT>          }<a name="line.78"></a>
<FONT color="green">079</FONT>        };<a name="line.79"></a>
<FONT color="green">080</FONT>        add(selfUpdateBehavior);<a name="line.80"></a>
<FONT color="green">081</FONT>      }<a name="line.81"></a>
<FONT color="green">082</FONT>      /**<a name="line.82"></a>
<FONT color="green">083</FONT>       * visible when data loading is in process or data loading end with error.<a name="line.83"></a>
<FONT color="green">084</FONT>       * @return true if this panel is visible.<a name="line.84"></a>
<FONT color="green">085</FONT>       */<a name="line.85"></a>
<FONT color="green">086</FONT>      @Override<a name="line.86"></a>
<FONT color="green">087</FONT>      public boolean isVisible() {<a name="line.87"></a>
<FONT color="green">088</FONT>        return dataModel.isInProcess() || !dataModel.isComplete();<a name="line.88"></a>
<FONT color="green">089</FONT>      }<a name="line.89"></a>
<FONT color="green">090</FONT>      <a name="line.90"></a>
<FONT color="green">091</FONT>      /**<a name="line.91"></a>
<FONT color="green">092</FONT>       * The method called when loading process is completed.<a name="line.92"></a>
<FONT color="green">093</FONT>       * @param target an AjaxRequestTarget.<a name="line.93"></a>
<FONT color="green">094</FONT>       */<a name="line.94"></a>
<FONT color="green">095</FONT>      protected void onFinished(AjaxRequestTarget target) {<a name="line.95"></a>
<FONT color="green">096</FONT>        //do nothing here. add implementation in subclasses.<a name="line.96"></a>
<FONT color="green">097</FONT>      }<a name="line.97"></a>
<FONT color="green">098</FONT>    }<a name="line.98"></a>




























































</PRE>
</BODY>
</HTML>
